<html dir="ltr">
	<head>
		<title>NDocBuilder Documentation</title>
		<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
		<meta content="http://schemas.microsoft.com/intellisense/ie5" name="vs_targetSchema">
		<xml></xml><LINK href="MSDN.css" type="text/css" rel="stylesheet">
		<script language="javascript">
		function openNewWindow(strUrl){window.open(strUrl, '_blank');} // Open the given url in a new window
		</script>
	</head>
	<body class="dtBODY" id="bodyID">
		<div id="nsbanner">
			<div id="bannerrow1">
				<table class="bannerparthead" id="Table1" cellSpacing="0">
					<tr id="hdr">
						<td class="runninghead">NDocBuilder Documentation</td>
						<td class="product"></td>
					</tr>
				</table>
			</div>
			<div id="TitleRow">
				<h1 class="dtH1">NDocBuilder</h1>
			</div>
		</div>
		<div id="nstext">
			<p>The <A href="javascript:openNewWindow('http://ndoc.sourceforge.net/');">NDoc 
					compiler</A> generates MSDN lookalike documentation from .NET assemblies 
				and the XML documentation files generated by the C# compiler. The documentation file you're looking at right now is generated with NDoc as well.<br/>
				<br/>
				Setting up a new NDoc project with the same settings for every Visual Studio project can be a 
				repeative task. Especially if this Visual Studio project has references to 
				other projects which you want to document too.<br>
				<br>
				This is where NDocBuilder comes in. <br>
				<br>
				NDocBuilder automatically creates the NDoc project, compiles the documentation and adds it to the current project. It can even compile documentation for multiple projects at once.<br>
				<br>
				<h3 class="dtH3">NDoc Project Files</h3>
				NDoc creates the documentation based on project files. These project files contains information like what title to give the help file, which assemblies are used and where the xml documentation files are located. 
				The project files are in XML format and can be edited either with <i>NDocGui.exe</i>
				or manually. The NDocBuilder plugin will create this project file automatically based on the current project and launch NDoc to build the documentation.<br>
				<h3 class="dtH3">Installing NDocBuilder</h3>
				Before you start the installation make sure all instances of Visual Studio are 
				closed. Start the <i>setup.exe</i> found in the NDocBuilderSetup folder and 
				follow the instructions of the installation wizard.<br>
				<br>
				<h3 class="dtH3">Documentation</h3>
				<div class="tablediv">
					<table class="dtTABLE" cellspacing="0" ID="Table2">
						<tr valign="top">
							<th width="50%">Subject</th>
							<th width="50%">Description</th>
						</tr>
						<tr valign="top">
							<td width="50%">
								<a href="TestingNDocBuilder.htm">Testing NDocBuilder</a>
							</td>
							<td width="50%">Tutorial to setup xml documentation and to create a simple MSDN helpfile.</td>
						</tr>
						<tr valign="top">
							<td width="50%">
								<a href="DocumentatingNamespaces.htm">Documentating Namespaces</a>
							</td>
							<td width="50%">Tutorial how to add xml documentation to namespaces.</td>
						</tr>
						<tr valign="top">
							<td width="50%">
								<a href="IncludingResources.htm">Including Resources</a>
							</td>
							<td width="50%">Explains how to add resources (images) to your documentation.</td>
						</tr>
						<tr valign="top">
							<td width="50%">
								<a href="AlternativeStartpage.htm">Alternative Startpage</a>
							</td>
							<td width="50%">Shows how to use a different startup page.</td>
						</tr>
						<tr valign="top">
							<td width="50%">
								<a href="NDocBuilderConfiguration.htm">NDocBuilder Configuration</a>
							</td>
							<td width="50%">Explanation of the configuration file used by NDocBuilder.</td>
						</tr>
						<tr valign="top">
							<td width="50%">
								<a href="NDocBuilder.html">NDocBuilder source code documentation</a>
							</td>
							<td width="50%">Documentation of the source code</td>
						</tr>
						<tr valign="top">
							<td width="50%">
								<a href="ms-help://MS.VSCC.2003/MS.MSDNQTR.2003FEB.1033/csref/html/vcwlkXMLDocumentationTutorial.htm">XML documentation</a>
							</td>
							<td width="50%">MSDN tutorial about creating XML documentation</td>
						</tr>
						
					</table>
				</div>
				<hr>
			<div id="footer">
				<p>
				</p>
				<p>
				</p>
			</div>
		</div>
	</body>
</html>
